UpdateSelectionWithSpans(IEnumerable<DocumentSpan>,Boolean) Method

Allows one or more DocumentSpans to be applied to the selection as an atomic operation.

Syntax

Visual Basic

'Declaration
 
Public Sub UpdateSelectionWithSpans( _
   ByVal spans As IEnumerable(Of DocumentSpan), _
   Optional ByVal replaceEntireSelection As Boolean _
) 

C#

public void UpdateSelectionWithSpans( 
   IEnumerable<DocumentSpan> spans,
   bool replaceEntireSelection
)

Parameters

spans

An IEnumerable of DocumentSpans that should be applied to the current selection.

replaceEntireSelection

True to replace the currently selected ranges or false to add the provided spans to the currently selected ranges.

Remarks

Note that no change notifications are sent until all spans have been added at which point a single notification is sent. Also, the start and end of the last provided span will be applied to the primary selection (i.e., the value returned by the Range property. The provided spans will either be added to the currently selected ranges or entirely replace the currently selected ranges depending on the value supplied for the replaceEntireSelection paramater.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2